<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: SQLSchemaUpdater.html 947 2014-11-12 22:14:09Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.schema;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.sql.Connection;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.sql.PreparedStatement;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.sql.ResultSet;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import java.sql.SQLException;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import java.sql.Statement;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import java.util.Date;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import java.util.HashSet;<a name="line.16"></a>
<span class="sourceLineNo">017</span>import java.util.Set;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import javax.sql.DataSource;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>/**<a name="line.21"></a>
<span class="sourceLineNo">022</span> * Concrete extension of {@link AbstractSchemaUpdater} for SQL databases.<a name="line.22"></a>
<span class="sourceLineNo">023</span> *<a name="line.23"></a>
<span class="sourceLineNo">024</span> * &lt;p&gt;<a name="line.24"></a>
<span class="sourceLineNo">025</span> * Required properties are the {@linkplain #setDatabaseInitialization database initialization},<a name="line.25"></a>
<span class="sourceLineNo">026</span> * {@linkplain #setUpdateTableInitialization update table initialization}, and the {@linkplain #setUpdates updates} themselves.<a name="line.26"></a>
<span class="sourceLineNo">027</span> * &lt;/p&gt;<a name="line.27"></a>
<span class="sourceLineNo">028</span> *<a name="line.28"></a>
<span class="sourceLineNo">029</span> * &lt;p&gt;<a name="line.29"></a>
<span class="sourceLineNo">030</span> * Applied updates are recorded in a special &lt;i&gt;update table&lt;/i&gt;, which contains two columns: one for the unique<a name="line.30"></a>
<span class="sourceLineNo">031</span> * {@linkplain SchemaUpdate#getName update name} and one for a timestamp. The update table and column names<a name="line.31"></a>
<span class="sourceLineNo">032</span> * are configurable via {@link #setUpdateTableName setUpdateTableName()},<a name="line.32"></a>
<span class="sourceLineNo">033</span> * {@link #setUpdateTableNameColumn setUpdateTableNameColumn()}, and {@link #setUpdateTableTimeColumn setUpdateTableTimeColumn()}.<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;/p&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> *<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;p&gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> * By default, this class detects a completely uninitialized database by the absence of the update table itself<a name="line.37"></a>
<span class="sourceLineNo">038</span> * in the schema (see {@link #databaseNeedsInitialization databaseNeedsInitialization()}).<a name="line.38"></a>
<span class="sourceLineNo">039</span> * When an uninitialized database is encountered, the configured {@linkplain #setDatabaseInitialization database initialization}<a name="line.39"></a>
<span class="sourceLineNo">040</span> * and {@linkplain #setUpdateTableInitialization update table initialization} actions are applied first to initialize<a name="line.40"></a>
<span class="sourceLineNo">041</span> * the database schema.<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &lt;/p&gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span> */<a name="line.43"></a>
<span class="sourceLineNo">044</span>public class SQLSchemaUpdater extends AbstractSchemaUpdater&lt;DataSource, Connection&gt; {<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span>    /**<a name="line.46"></a>
<span class="sourceLineNo">047</span>     * Default name of the table that tracks schema updates, &lt;code&gt;{@value}&lt;/code&gt;.<a name="line.47"></a>
<span class="sourceLineNo">048</span>     */<a name="line.48"></a>
<span class="sourceLineNo">049</span>    public static final String DEFAULT_UPDATE_TABLE_NAME = "SchemaUpdate";<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span>    /**<a name="line.51"></a>
<span class="sourceLineNo">052</span>     * Default name of the column in the updates table holding the unique update name, &lt;code&gt;{@value}&lt;/code&gt;.<a name="line.52"></a>
<span class="sourceLineNo">053</span>     */<a name="line.53"></a>
<span class="sourceLineNo">054</span>    public static final String DEFAULT_UPDATE_TABLE_NAME_COLUMN = "updateName";<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span>    /**<a name="line.56"></a>
<span class="sourceLineNo">057</span>     * Default name of the column in the updates table holding the update's time applied, &lt;code&gt;{@value}&lt;/code&gt;.<a name="line.57"></a>
<span class="sourceLineNo">058</span>     */<a name="line.58"></a>
<span class="sourceLineNo">059</span>    public static final String DEFAULT_UPDATE_TABLE_TIME_COLUMN = "updateTime";<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span>    private String updateTableName = DEFAULT_UPDATE_TABLE_NAME;<a name="line.61"></a>
<span class="sourceLineNo">062</span>    private String updateTableNameColumn = DEFAULT_UPDATE_TABLE_NAME_COLUMN;<a name="line.62"></a>
<span class="sourceLineNo">063</span>    private String updateTableTimeColumn = DEFAULT_UPDATE_TABLE_TIME_COLUMN;<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span>    private SQLCommandList databaseInitialization;<a name="line.65"></a>
<span class="sourceLineNo">066</span>    private SQLCommandList updateTableInitialization;<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span>    /**<a name="line.68"></a>
<span class="sourceLineNo">069</span>     * Get the name of the table that keeps track of applied updates.<a name="line.69"></a>
<span class="sourceLineNo">070</span>     *<a name="line.70"></a>
<span class="sourceLineNo">071</span>     * @see #setUpdateTableName setUpdateTableName()<a name="line.71"></a>
<span class="sourceLineNo">072</span>     */<a name="line.72"></a>
<span class="sourceLineNo">073</span>    public String getUpdateTableName() {<a name="line.73"></a>
<span class="sourceLineNo">074</span>        return this.updateTableName;<a name="line.74"></a>
<span class="sourceLineNo">075</span>    }<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span>    /**<a name="line.77"></a>
<span class="sourceLineNo">078</span>     * Set the name of the table that keeps track of applied updates.<a name="line.78"></a>
<span class="sourceLineNo">079</span>     * Default value is {@link #DEFAULT_UPDATE_TABLE_NAME}.<a name="line.79"></a>
<span class="sourceLineNo">080</span>     *<a name="line.80"></a>
<span class="sourceLineNo">081</span>     * &lt;p&gt;<a name="line.81"></a>
<span class="sourceLineNo">082</span>     * This name must be consistent with the {@linkplain #setUpdateTableInitialization update table initialization}.<a name="line.82"></a>
<span class="sourceLineNo">083</span>     */<a name="line.83"></a>
<span class="sourceLineNo">084</span>    public void setUpdateTableName(String updateTableName) {<a name="line.84"></a>
<span class="sourceLineNo">085</span>        this.updateTableName = updateTableName;<a name="line.85"></a>
<span class="sourceLineNo">086</span>    }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span>    /**<a name="line.88"></a>
<span class="sourceLineNo">089</span>     * Get the name of the update name column in the table that keeps track of applied updates.<a name="line.89"></a>
<span class="sourceLineNo">090</span>     *<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * @see #setUpdateTableNameColumn setUpdateTableNameColumn()<a name="line.91"></a>
<span class="sourceLineNo">092</span>     */<a name="line.92"></a>
<span class="sourceLineNo">093</span>    public String getUpdateTableNameColumn() {<a name="line.93"></a>
<span class="sourceLineNo">094</span>        return this.updateTableNameColumn;<a name="line.94"></a>
<span class="sourceLineNo">095</span>    }<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span>    /**<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * Set the name of the update name column in the table that keeps track of applied updates.<a name="line.98"></a>
<span class="sourceLineNo">099</span>     * Default value is {@link #DEFAULT_UPDATE_TABLE_NAME_COLUMN}.<a name="line.99"></a>
<span class="sourceLineNo">100</span>     *<a name="line.100"></a>
<span class="sourceLineNo">101</span>     * &lt;p&gt;<a name="line.101"></a>
<span class="sourceLineNo">102</span>     * This name must be consistent with the {@linkplain #setUpdateTableInitialization update table initialization}.<a name="line.102"></a>
<span class="sourceLineNo">103</span>     */<a name="line.103"></a>
<span class="sourceLineNo">104</span>    public void setUpdateTableNameColumn(String updateTableNameColumn) {<a name="line.104"></a>
<span class="sourceLineNo">105</span>        this.updateTableNameColumn = updateTableNameColumn;<a name="line.105"></a>
<span class="sourceLineNo">106</span>    }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span>    /**<a name="line.108"></a>
<span class="sourceLineNo">109</span>     * Get the name of the update timestamp column in the table that keeps track of applied updates.<a name="line.109"></a>
<span class="sourceLineNo">110</span>     *<a name="line.110"></a>
<span class="sourceLineNo">111</span>     * @see #setUpdateTableTimeColumn setUpdateTableTimeColumn()<a name="line.111"></a>
<span class="sourceLineNo">112</span>     */<a name="line.112"></a>
<span class="sourceLineNo">113</span>    public String getUpdateTableTimeColumn() {<a name="line.113"></a>
<span class="sourceLineNo">114</span>        return this.updateTableTimeColumn;<a name="line.114"></a>
<span class="sourceLineNo">115</span>    }<a name="line.115"></a>
<span class="sourceLineNo">116</span><a name="line.116"></a>
<span class="sourceLineNo">117</span>    /**<a name="line.117"></a>
<span class="sourceLineNo">118</span>     * Set the name of the update timestamp column in the table that keeps track of applied updates.<a name="line.118"></a>
<span class="sourceLineNo">119</span>     * Default value is {@link #DEFAULT_UPDATE_TABLE_TIME_COLUMN}.<a name="line.119"></a>
<span class="sourceLineNo">120</span>     *<a name="line.120"></a>
<span class="sourceLineNo">121</span>     * &lt;p&gt;<a name="line.121"></a>
<span class="sourceLineNo">122</span>     * This name must be consistent with the {@linkplain #setUpdateTableInitialization update table initialization}.<a name="line.122"></a>
<span class="sourceLineNo">123</span>     */<a name="line.123"></a>
<span class="sourceLineNo">124</span>    public void setUpdateTableTimeColumn(String updateTableTimeColumn) {<a name="line.124"></a>
<span class="sourceLineNo">125</span>        this.updateTableTimeColumn = updateTableTimeColumn;<a name="line.125"></a>
<span class="sourceLineNo">126</span>    }<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span>    /**<a name="line.128"></a>
<span class="sourceLineNo">129</span>     * Get the update table initialization.<a name="line.129"></a>
<span class="sourceLineNo">130</span>     *<a name="line.130"></a>
<span class="sourceLineNo">131</span>     * @see #setUpdateTableInitialization setUpdateTableInitialization()<a name="line.131"></a>
<span class="sourceLineNo">132</span>     */<a name="line.132"></a>
<span class="sourceLineNo">133</span>    public SQLCommandList getUpdateTableInitialization() {<a name="line.133"></a>
<span class="sourceLineNo">134</span>        return this.updateTableInitialization;<a name="line.134"></a>
<span class="sourceLineNo">135</span>    }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span>    /**<a name="line.137"></a>
<span class="sourceLineNo">138</span>     * Configure how the update table itself gets initialized. This update is run when no update table found,<a name="line.138"></a>
<span class="sourceLineNo">139</span>     * which (we assume) implies an empty database with no tables or content. This is a required property.<a name="line.139"></a>
<span class="sourceLineNo">140</span>     *<a name="line.140"></a>
<span class="sourceLineNo">141</span>     * &lt;p&gt;<a name="line.141"></a>
<span class="sourceLineNo">142</span>     * This initialization should create the update table where the name column is the primary key.<a name="line.142"></a>
<span class="sourceLineNo">143</span>     * The name column must have a length limit greater than or equal to the longest schema update name.<a name="line.143"></a>
<span class="sourceLineNo">144</span>     *<a name="line.144"></a>
<span class="sourceLineNo">145</span>     * &lt;p&gt;<a name="line.145"></a>
<span class="sourceLineNo">146</span>     * The table and column names must be consistent with the values configured via<a name="line.146"></a>
<span class="sourceLineNo">147</span>     * {@link #setUpdateTableName setUpdateTableName()}, {@link #setUpdateTableNameColumn setUpdateTableNameColumn()},<a name="line.147"></a>
<span class="sourceLineNo">148</span>     * and {@link #setUpdateTableTimeColumn setUpdateTableTimeColumn()}.<a name="line.148"></a>
<span class="sourceLineNo">149</span>     *<a name="line.149"></a>
<span class="sourceLineNo">150</span>     * &lt;p&gt;<a name="line.150"></a>
<span class="sourceLineNo">151</span>     * For convenience, pre-defined initialization scripts using the default table and column names are available<a name="line.151"></a>
<span class="sourceLineNo">152</span>     * at the following resource locations. These can be used to configure a {@link SQLCommandList}:<a name="line.152"></a>
<span class="sourceLineNo">153</span>     * &lt;table border="1" cellspacing="0" cellpadding="4"&gt;<a name="line.153"></a>
<span class="sourceLineNo">154</span>     * &lt;tr&gt;<a name="line.154"></a>
<span class="sourceLineNo">155</span>     * &lt;th&gt;Database&lt;/th&gt;<a name="line.155"></a>
<span class="sourceLineNo">156</span>     * &lt;th&gt;Resource&lt;/th&gt;<a name="line.156"></a>
<span class="sourceLineNo">157</span>     * &lt;/tr&gt;<a name="line.157"></a>
<span class="sourceLineNo">158</span>     * &lt;tr&gt;<a name="line.158"></a>
<span class="sourceLineNo">159</span>     * &lt;/tr&gt;<a name="line.159"></a>
<span class="sourceLineNo">160</span>     * &lt;td&gt;MySQL (InnoDB)&lt;/td&gt;<a name="line.160"></a>
<span class="sourceLineNo">161</span>     * &lt;td&gt;&lt;code&gt;classpath:org/dellroad/stuff/schema/updateTable-mysql.sql&lt;/code&gt;&lt;/td&gt;<a name="line.161"></a>
<span class="sourceLineNo">162</span>     * &lt;/tr&gt;<a name="line.162"></a>
<span class="sourceLineNo">163</span>     * &lt;/table&gt;<a name="line.163"></a>
<span class="sourceLineNo">164</span>     *<a name="line.164"></a>
<span class="sourceLineNo">165</span>     * @param updateTableInitialization update table schema initialization<a name="line.165"></a>
<span class="sourceLineNo">166</span>     * @see #setUpdateTableName setUpdateTableName()<a name="line.166"></a>
<span class="sourceLineNo">167</span>     * @see #setUpdateTableNameColumn setUpdateTableNameColumn()<a name="line.167"></a>
<span class="sourceLineNo">168</span>     * @see #setUpdateTableTimeColumn setUpdateTableTimeColumn()<a name="line.168"></a>
<span class="sourceLineNo">169</span>     */<a name="line.169"></a>
<span class="sourceLineNo">170</span>    public void setUpdateTableInitialization(SQLCommandList updateTableInitialization) {<a name="line.170"></a>
<span class="sourceLineNo">171</span>        this.updateTableInitialization = updateTableInitialization;<a name="line.171"></a>
<span class="sourceLineNo">172</span>    }<a name="line.172"></a>
<span class="sourceLineNo">173</span><a name="line.173"></a>
<span class="sourceLineNo">174</span>    /**<a name="line.174"></a>
<span class="sourceLineNo">175</span>     * Get the empty database initialization.<a name="line.175"></a>
<span class="sourceLineNo">176</span>     *<a name="line.176"></a>
<span class="sourceLineNo">177</span>     * @see #setDatabaseInitialization setDatabaseInitialization()<a name="line.177"></a>
<span class="sourceLineNo">178</span>     */<a name="line.178"></a>
<span class="sourceLineNo">179</span>    public SQLCommandList getDatabaseInitialization() {<a name="line.179"></a>
<span class="sourceLineNo">180</span>        return this.databaseInitialization;<a name="line.180"></a>
<span class="sourceLineNo">181</span>    }<a name="line.181"></a>
<span class="sourceLineNo">182</span><a name="line.182"></a>
<span class="sourceLineNo">183</span>    /**<a name="line.183"></a>
<span class="sourceLineNo">184</span>     * Configure how an empty database gets initialized. This is a required property.<a name="line.184"></a>
<span class="sourceLineNo">185</span>     *<a name="line.185"></a>
<span class="sourceLineNo">186</span>     * &lt;p&gt;<a name="line.186"></a>
<span class="sourceLineNo">187</span>     * This update is run when no update table found, which (we assume) implies an empty database with no tables or content.<a name="line.187"></a>
<span class="sourceLineNo">188</span>     * Typically this contains the SQL script that gets automatically generated by your favorite schema generation tool.<a name="line.188"></a>
<span class="sourceLineNo">189</span>     *<a name="line.189"></a>
<span class="sourceLineNo">190</span>     * &lt;p&gt;<a name="line.190"></a>
<span class="sourceLineNo">191</span>     * This script is expected to initialize the database schema (i.e., creating all the tables) so that<a name="line.191"></a>
<span class="sourceLineNo">192</span>     * when completed the database is "up to date" with respect to the configured schema updates.<a name="line.192"></a>
<span class="sourceLineNo">193</span>     * That is, when this action completes, we assume all updates have already been (implicitly) applied<a name="line.193"></a>
<span class="sourceLineNo">194</span>     * (and they will be recorded as such).<a name="line.194"></a>
<span class="sourceLineNo">195</span>     *<a name="line.195"></a>
<span class="sourceLineNo">196</span>     * &lt;p&gt;<a name="line.196"></a>
<span class="sourceLineNo">197</span>     * Note this script is &lt;i&gt;not&lt;/i&gt; expected to create the update table that tracks schema updates;<a name="line.197"></a>
<span class="sourceLineNo">198</span>     * that function is handled by the {@linkplain #setUpdateTableInitialization update table initialization}.<a name="line.198"></a>
<span class="sourceLineNo">199</span>     *<a name="line.199"></a>
<span class="sourceLineNo">200</span>     * @param databaseInitialization application database schema initialization<a name="line.200"></a>
<span class="sourceLineNo">201</span>     */<a name="line.201"></a>
<span class="sourceLineNo">202</span>    public void setDatabaseInitialization(SQLCommandList databaseInitialization) {<a name="line.202"></a>
<span class="sourceLineNo">203</span>        this.databaseInitialization = databaseInitialization;<a name="line.203"></a>
<span class="sourceLineNo">204</span>    }<a name="line.204"></a>
<span class="sourceLineNo">205</span><a name="line.205"></a>
<span class="sourceLineNo">206</span>    @Override<a name="line.206"></a>
<span class="sourceLineNo">207</span>    protected void apply(Connection c, DatabaseAction&lt;Connection&gt; action) throws SQLException {<a name="line.207"></a>
<span class="sourceLineNo">208</span>        try {<a name="line.208"></a>
<span class="sourceLineNo">209</span>            super.apply(c, action);<a name="line.209"></a>
<span class="sourceLineNo">210</span>        } catch (SQLException e) {<a name="line.210"></a>
<span class="sourceLineNo">211</span>            throw e;<a name="line.211"></a>
<span class="sourceLineNo">212</span>        } catch (RuntimeException e) {<a name="line.212"></a>
<span class="sourceLineNo">213</span>            throw e;<a name="line.213"></a>
<span class="sourceLineNo">214</span>        } catch (Error e) {<a name="line.214"></a>
<span class="sourceLineNo">215</span>            throw e;<a name="line.215"></a>
<span class="sourceLineNo">216</span>        } catch (Exception e) {<a name="line.216"></a>
<span class="sourceLineNo">217</span>            throw new RuntimeException(e);<a name="line.217"></a>
<span class="sourceLineNo">218</span>        }<a name="line.218"></a>
<span class="sourceLineNo">219</span>    }<a name="line.219"></a>
<span class="sourceLineNo">220</span><a name="line.220"></a>
<span class="sourceLineNo">221</span>    /**<a name="line.221"></a>
<span class="sourceLineNo">222</span>     * @throws Exception {@inheritDoc}<a name="line.222"></a>
<span class="sourceLineNo">223</span>     * @throws IllegalStateException if the database needs initialization and either the<a name="line.223"></a>
<span class="sourceLineNo">224</span>     *  {@linkplain #setDatabaseInitialization database initialization} or<a name="line.224"></a>
<span class="sourceLineNo">225</span>     *  the {@linkplain #setUpdateTableInitialization update table initialization} has not been configured<a name="line.225"></a>
<span class="sourceLineNo">226</span>     * @throws IllegalStateException {@inheritDoc}<a name="line.226"></a>
<span class="sourceLineNo">227</span>     * @throws IllegalArgumentException {@inheritDoc}<a name="line.227"></a>
<span class="sourceLineNo">228</span>     */<a name="line.228"></a>
<span class="sourceLineNo">229</span>    @Override<a name="line.229"></a>
<span class="sourceLineNo">230</span>    public synchronized void initializeAndUpdateDatabase(DataSource dataSource) throws SQLException {<a name="line.230"></a>
<span class="sourceLineNo">231</span>        try {<a name="line.231"></a>
<span class="sourceLineNo">232</span>            super.initializeAndUpdateDatabase(dataSource);<a name="line.232"></a>
<span class="sourceLineNo">233</span>        } catch (SQLException e) {<a name="line.233"></a>
<span class="sourceLineNo">234</span>            throw e;<a name="line.234"></a>
<span class="sourceLineNo">235</span>        } catch (RuntimeException e) {<a name="line.235"></a>
<span class="sourceLineNo">236</span>            throw e;<a name="line.236"></a>
<span class="sourceLineNo">237</span>        } catch (Error e) {<a name="line.237"></a>
<span class="sourceLineNo">238</span>            throw e;<a name="line.238"></a>
<span class="sourceLineNo">239</span>        } catch (Exception e) {<a name="line.239"></a>
<span class="sourceLineNo">240</span>            throw new RuntimeException(e);<a name="line.240"></a>
<span class="sourceLineNo">241</span>        }<a name="line.241"></a>
<span class="sourceLineNo">242</span>    }<a name="line.242"></a>
<span class="sourceLineNo">243</span><a name="line.243"></a>
<span class="sourceLineNo">244</span>    /**<a name="line.244"></a>
<span class="sourceLineNo">245</span>     * Begin a transaction on the given connection.<a name="line.245"></a>
<span class="sourceLineNo">246</span>     *<a name="line.246"></a>
<span class="sourceLineNo">247</span>     * &lt;p&gt;<a name="line.247"></a>
<span class="sourceLineNo">248</span>     * The implementation in {@link SQLSchemaUpdater} creates a serializable-level transaction.<a name="line.248"></a>
<span class="sourceLineNo">249</span>     *<a name="line.249"></a>
<span class="sourceLineNo">250</span>     * @param dataSource the database on which to open the transaction<a name="line.250"></a>
<span class="sourceLineNo">251</span>     * @return new {@link Connection} with an open transaction<a name="line.251"></a>
<span class="sourceLineNo">252</span>     * @throws SQLException if an error occurs while accessing the database<a name="line.252"></a>
<span class="sourceLineNo">253</span>     */<a name="line.253"></a>
<span class="sourceLineNo">254</span>    @Override<a name="line.254"></a>
<span class="sourceLineNo">255</span>    protected Connection openTransaction(DataSource dataSource) throws SQLException {<a name="line.255"></a>
<span class="sourceLineNo">256</span>        Connection c = dataSource.getConnection();<a name="line.256"></a>
<span class="sourceLineNo">257</span>        c.setTransactionIsolation(Connection.TRANSACTION_SERIALIZABLE);<a name="line.257"></a>
<span class="sourceLineNo">258</span>        c.setAutoCommit(false);<a name="line.258"></a>
<span class="sourceLineNo">259</span>        return c;<a name="line.259"></a>
<span class="sourceLineNo">260</span>    }<a name="line.260"></a>
<span class="sourceLineNo">261</span><a name="line.261"></a>
<span class="sourceLineNo">262</span>    /**<a name="line.262"></a>
<span class="sourceLineNo">263</span>     * Commit a previously opened transaction.<a name="line.263"></a>
<span class="sourceLineNo">264</span>     *<a name="line.264"></a>
<span class="sourceLineNo">265</span>     * &lt;p&gt;<a name="line.265"></a>
<span class="sourceLineNo">266</span>     * The implementation in {@link SQLSchemaUpdater} just invokes {@link Connection#commit}.<a name="line.266"></a>
<span class="sourceLineNo">267</span>     *<a name="line.267"></a>
<span class="sourceLineNo">268</span>     * @param c the connection on which to commit the transaction<a name="line.268"></a>
<span class="sourceLineNo">269</span>     * @throws SQLException if an error occurs while accessing the database<a name="line.269"></a>
<span class="sourceLineNo">270</span>     */<a name="line.270"></a>
<span class="sourceLineNo">271</span>    @Override<a name="line.271"></a>
<span class="sourceLineNo">272</span>    protected void commitTransaction(Connection c) throws SQLException {<a name="line.272"></a>
<span class="sourceLineNo">273</span>        c.commit();<a name="line.273"></a>
<span class="sourceLineNo">274</span>        c.close();<a name="line.274"></a>
<span class="sourceLineNo">275</span>    }<a name="line.275"></a>
<span class="sourceLineNo">276</span><a name="line.276"></a>
<span class="sourceLineNo">277</span>    /**<a name="line.277"></a>
<span class="sourceLineNo">278</span>     * Roll back a previously opened transaction.<a name="line.278"></a>
<span class="sourceLineNo">279</span>     * This method will also be invoked if {@link #commitTransaction commitTransaction()} throws an exception.<a name="line.279"></a>
<span class="sourceLineNo">280</span>     *<a name="line.280"></a>
<span class="sourceLineNo">281</span>     * &lt;p&gt;<a name="line.281"></a>
<span class="sourceLineNo">282</span>     * The implementation in {@link SQLSchemaUpdater} just invokes {@link Connection#rollback}.<a name="line.282"></a>
<span class="sourceLineNo">283</span>     *<a name="line.283"></a>
<span class="sourceLineNo">284</span>     * @param c the connection on which to roll back the transaction<a name="line.284"></a>
<span class="sourceLineNo">285</span>     * @throws SQLException if an error occurs while accessing the database<a name="line.285"></a>
<span class="sourceLineNo">286</span>     */<a name="line.286"></a>
<span class="sourceLineNo">287</span>    @Override<a name="line.287"></a>
<span class="sourceLineNo">288</span>    protected void rollbackTransaction(Connection c) throws SQLException {<a name="line.288"></a>
<span class="sourceLineNo">289</span>        c.rollback();<a name="line.289"></a>
<span class="sourceLineNo">290</span>        c.close();<a name="line.290"></a>
<span class="sourceLineNo">291</span>    }<a name="line.291"></a>
<span class="sourceLineNo">292</span><a name="line.292"></a>
<span class="sourceLineNo">293</span>    /**<a name="line.293"></a>
<span class="sourceLineNo">294</span>     * Determine if the database needs initialization.<a name="line.294"></a>
<span class="sourceLineNo">295</span>     *<a name="line.295"></a>
<span class="sourceLineNo">296</span>     * &lt;p&gt;<a name="line.296"></a>
<span class="sourceLineNo">297</span>     * The implementation in {@link SQLSchemaUpdater} simply invokes &lt;code&gt;SELECT COUNT(*) FROM &lt;i&gt;UPDATETABLE&lt;/i&gt;&lt;/code&gt;<a name="line.297"></a>
<span class="sourceLineNo">298</span>     * and checks for success or failure. If an exception is thrown, {@link #indicatesUninitializedDatabase} is used<a name="line.298"></a>
<span class="sourceLineNo">299</span>     * to distinguish between an exception caused by an uninitialized database and a truly unexpected one.<a name="line.299"></a>
<span class="sourceLineNo">300</span>     *<a name="line.300"></a>
<span class="sourceLineNo">301</span>     * @param c connection to the database<a name="line.301"></a>
<span class="sourceLineNo">302</span>     * @throws SQLException if an unexpected error occurs while accessing the database<a name="line.302"></a>
<span class="sourceLineNo">303</span>     */<a name="line.303"></a>
<span class="sourceLineNo">304</span>    @Override<a name="line.304"></a>
<span class="sourceLineNo">305</span>    protected boolean databaseNeedsInitialization(Connection c) throws SQLException {<a name="line.305"></a>
<span class="sourceLineNo">306</span>        final boolean[] result = new boolean[1];<a name="line.306"></a>
<span class="sourceLineNo">307</span>        this.apply(c, new SQLCommand("SELECT COUNT(*) FROM " + this.getUpdateTableName()) {<a name="line.307"></a>
<span class="sourceLineNo">308</span>            @Override<a name="line.308"></a>
<span class="sourceLineNo">309</span>            public void apply(Connection c) throws SQLException {<a name="line.309"></a>
<span class="sourceLineNo">310</span>                Statement s = c.createStatement();<a name="line.310"></a>
<span class="sourceLineNo">311</span>                try {<a name="line.311"></a>
<span class="sourceLineNo">312</span>                    ResultSet resultSet;<a name="line.312"></a>
<span class="sourceLineNo">313</span>                    try {<a name="line.313"></a>
<span class="sourceLineNo">314</span>                        resultSet = s.executeQuery(this.getSQL());<a name="line.314"></a>
<span class="sourceLineNo">315</span>                    } catch (SQLException e) {<a name="line.315"></a>
<span class="sourceLineNo">316</span>                        if (SQLSchemaUpdater.this.indicatesUninitializedDatabase(c, e)) {<a name="line.316"></a>
<span class="sourceLineNo">317</span>                            SQLSchemaUpdater.this.log.info("detected an uninitialized database");<a name="line.317"></a>
<span class="sourceLineNo">318</span>                            result[0] = true;<a name="line.318"></a>
<span class="sourceLineNo">319</span>                            return;<a name="line.319"></a>
<span class="sourceLineNo">320</span>                        }<a name="line.320"></a>
<span class="sourceLineNo">321</span>                        throw e;<a name="line.321"></a>
<span class="sourceLineNo">322</span>                    }<a name="line.322"></a>
<span class="sourceLineNo">323</span>                    if (!resultSet.next())<a name="line.323"></a>
<span class="sourceLineNo">324</span>                        throw new IllegalStateException("zero rows returned by `" + this.getSQL() + "'");<a name="line.324"></a>
<span class="sourceLineNo">325</span>                    SQLSchemaUpdater.this.log.info("detected initialized database, with "<a name="line.325"></a>
<span class="sourceLineNo">326</span>                      + resultSet.getLong(1) + " update(s) already applied");<a name="line.326"></a>
<span class="sourceLineNo">327</span>                } finally {<a name="line.327"></a>
<span class="sourceLineNo">328</span>                    s.close();<a name="line.328"></a>
<span class="sourceLineNo">329</span>                }<a name="line.329"></a>
<span class="sourceLineNo">330</span>            }<a name="line.330"></a>
<span class="sourceLineNo">331</span>        });<a name="line.331"></a>
<span class="sourceLineNo">332</span>        return result[0];<a name="line.332"></a>
<span class="sourceLineNo">333</span>    }<a name="line.333"></a>
<span class="sourceLineNo">334</span><a name="line.334"></a>
<span class="sourceLineNo">335</span>    /**<a name="line.335"></a>
<span class="sourceLineNo">336</span>     * Determine if an exception thrown during {@link #databaseNeedsInitialization} is consistent with<a name="line.336"></a>
<span class="sourceLineNo">337</span>     * an uninitialized database.<a name="line.337"></a>
<span class="sourceLineNo">338</span>     *<a name="line.338"></a>
<span class="sourceLineNo">339</span>     * &lt;p&gt;<a name="line.339"></a>
<span class="sourceLineNo">340</span>     * This should return true if the exception would be thrown by an SQL query that attempts to access a non-existent table.<a name="line.340"></a>
<span class="sourceLineNo">341</span>     * For exceptions thrown by other causes, this should return false.<a name="line.341"></a>
<span class="sourceLineNo">342</span>     *<a name="line.342"></a>
<span class="sourceLineNo">343</span>     * &lt;p&gt;<a name="line.343"></a>
<span class="sourceLineNo">344</span>     * The implementation in {@link SQLSchemaUpdater} always returns true. Subclasses are encouraged to override<a name="line.344"></a>
<span class="sourceLineNo">345</span>     * with a more precise implementation.<a name="line.345"></a>
<span class="sourceLineNo">346</span>     *<a name="line.346"></a>
<span class="sourceLineNo">347</span>     * @param c connection on which the exception occurred<a name="line.347"></a>
<span class="sourceLineNo">348</span>     * @param e exception thrown during database access in {@link #databaseNeedsInitialization}<a name="line.348"></a>
<span class="sourceLineNo">349</span>     * @see #databaseNeedsInitialization<a name="line.349"></a>
<span class="sourceLineNo">350</span>     * @throws SQLException if an error occurs<a name="line.350"></a>
<span class="sourceLineNo">351</span>     */<a name="line.351"></a>
<span class="sourceLineNo">352</span>    protected boolean indicatesUninitializedDatabase(Connection c, SQLException e) throws SQLException {<a name="line.352"></a>
<span class="sourceLineNo">353</span>        return true;<a name="line.353"></a>
<span class="sourceLineNo">354</span>    }<a name="line.354"></a>
<span class="sourceLineNo">355</span><a name="line.355"></a>
<span class="sourceLineNo">356</span>    /**<a name="line.356"></a>
<span class="sourceLineNo">357</span>     * Record an update as having been applied.<a name="line.357"></a>
<span class="sourceLineNo">358</span>     *<a name="line.358"></a>
<span class="sourceLineNo">359</span>     * &lt;p&gt;<a name="line.359"></a>
<span class="sourceLineNo">360</span>     * The implementation in {@link SQLSchemaUpdater} does the standard JDBC thing using an INSERT statement<a name="line.360"></a>
<span class="sourceLineNo">361</span>     * into the update table.<a name="line.361"></a>
<span class="sourceLineNo">362</span>     * &lt;/p&gt;<a name="line.362"></a>
<span class="sourceLineNo">363</span>     *<a name="line.363"></a>
<span class="sourceLineNo">364</span>     * @param c SQL connection<a name="line.364"></a>
<span class="sourceLineNo">365</span>     * @param updateName update name<a name="line.365"></a>
<span class="sourceLineNo">366</span>     * @throws IllegalStateException if the update has already been recorded in the database<a name="line.366"></a>
<span class="sourceLineNo">367</span>     * @throws SQLException if an error occurs while accessing the database<a name="line.367"></a>
<span class="sourceLineNo">368</span>     */<a name="line.368"></a>
<span class="sourceLineNo">369</span>    @Override<a name="line.369"></a>
<span class="sourceLineNo">370</span>    protected void recordUpdateApplied(Connection c, final String updateName) throws SQLException {<a name="line.370"></a>
<span class="sourceLineNo">371</span>        this.apply(c, new SQLCommand("INSERT INTO " + this.getUpdateTableName()<a name="line.371"></a>
<span class="sourceLineNo">372</span>          + " (" + this.getUpdateTableNameColumn() + ", " + this.getUpdateTableTimeColumn() + ") VALUES (?, ?)") {<a name="line.372"></a>
<span class="sourceLineNo">373</span>            @Override<a name="line.373"></a>
<span class="sourceLineNo">374</span>            public void apply(Connection c) throws SQLException {<a name="line.374"></a>
<span class="sourceLineNo">375</span>                PreparedStatement s = c.prepareStatement(this.getSQL());<a name="line.375"></a>
<span class="sourceLineNo">376</span>                try {<a name="line.376"></a>
<span class="sourceLineNo">377</span>                    s.setString(1, updateName);<a name="line.377"></a>
<span class="sourceLineNo">378</span>                    s.setDate(2, new java.sql.Date(new Date().getTime()));<a name="line.378"></a>
<span class="sourceLineNo">379</span>                    int rows = s.executeUpdate();<a name="line.379"></a>
<span class="sourceLineNo">380</span>                    if (rows != 1)<a name="line.380"></a>
<span class="sourceLineNo">381</span>                        throw new IllegalStateException("got " + rows + " != 1 rows for `" + this.getSQL() + "'");<a name="line.381"></a>
<span class="sourceLineNo">382</span>                } finally {<a name="line.382"></a>
<span class="sourceLineNo">383</span>                    s.close();<a name="line.383"></a>
<span class="sourceLineNo">384</span>                }<a name="line.384"></a>
<span class="sourceLineNo">385</span>            }<a name="line.385"></a>
<span class="sourceLineNo">386</span>        });<a name="line.386"></a>
<span class="sourceLineNo">387</span>    }<a name="line.387"></a>
<span class="sourceLineNo">388</span><a name="line.388"></a>
<span class="sourceLineNo">389</span>    /**<a name="line.389"></a>
<span class="sourceLineNo">390</span>     * Determine which updates have already been applied.<a name="line.390"></a>
<span class="sourceLineNo">391</span>     *<a name="line.391"></a>
<span class="sourceLineNo">392</span>     * &lt;p&gt;<a name="line.392"></a>
<span class="sourceLineNo">393</span>     * The implementation in {@link SQLSchemaUpdater} does the standard JDBC thing using a SELECT statement<a name="line.393"></a>
<span class="sourceLineNo">394</span>     * from the update table.<a name="line.394"></a>
<span class="sourceLineNo">395</span>     *<a name="line.395"></a>
<span class="sourceLineNo">396</span>     * @throws SQLException if an error occurs while accessing the database<a name="line.396"></a>
<span class="sourceLineNo">397</span>     */<a name="line.397"></a>
<span class="sourceLineNo">398</span>    @Override<a name="line.398"></a>
<span class="sourceLineNo">399</span>    protected Set&lt;String&gt; getAppliedUpdateNames(Connection c) throws SQLException {<a name="line.399"></a>
<span class="sourceLineNo">400</span>        final HashSet&lt;String&gt; updateNames = new HashSet&lt;String&gt;();<a name="line.400"></a>
<span class="sourceLineNo">401</span>        this.apply(c, new SQLCommand("SELECT " + this.getUpdateTableNameColumn() + " FROM " + this.getUpdateTableName()) {<a name="line.401"></a>
<span class="sourceLineNo">402</span>            @Override<a name="line.402"></a>
<span class="sourceLineNo">403</span>            public void apply(Connection c) throws SQLException {<a name="line.403"></a>
<span class="sourceLineNo">404</span>                Statement s = c.createStatement();<a name="line.404"></a>
<span class="sourceLineNo">405</span>                try {<a name="line.405"></a>
<span class="sourceLineNo">406</span>                    for (ResultSet resultSet = s.executeQuery(this.getSQL()); resultSet.next(); )<a name="line.406"></a>
<span class="sourceLineNo">407</span>                        updateNames.add(resultSet.getString(1));<a name="line.407"></a>
<span class="sourceLineNo">408</span>                } finally {<a name="line.408"></a>
<span class="sourceLineNo">409</span>                    s.close();<a name="line.409"></a>
<span class="sourceLineNo">410</span>                }<a name="line.410"></a>
<span class="sourceLineNo">411</span>            }<a name="line.411"></a>
<span class="sourceLineNo">412</span>        });<a name="line.412"></a>
<span class="sourceLineNo">413</span>        return updateNames;<a name="line.413"></a>
<span class="sourceLineNo">414</span>    }<a name="line.414"></a>
<span class="sourceLineNo">415</span><a name="line.415"></a>
<span class="sourceLineNo">416</span>    // Initialize the database<a name="line.416"></a>
<span class="sourceLineNo">417</span>    @Override<a name="line.417"></a>
<span class="sourceLineNo">418</span>    protected void initializeDatabase(Connection c) throws SQLException {<a name="line.418"></a>
<span class="sourceLineNo">419</span><a name="line.419"></a>
<span class="sourceLineNo">420</span>        // Sanity check<a name="line.420"></a>
<span class="sourceLineNo">421</span>        if (this.getDatabaseInitialization() == null)<a name="line.421"></a>
<span class="sourceLineNo">422</span>            throw new IllegalArgumentException("database needs initialization but no database initialization is configured");<a name="line.422"></a>
<span class="sourceLineNo">423</span>        if (this.getUpdateTableInitialization() == null)<a name="line.423"></a>
<span class="sourceLineNo">424</span>            throw new IllegalArgumentException("database needs initialization but no update table initialization is configured");<a name="line.424"></a>
<span class="sourceLineNo">425</span><a name="line.425"></a>
<span class="sourceLineNo">426</span>        // Initialize application schema<a name="line.426"></a>
<span class="sourceLineNo">427</span>        this.log.info("intializing database schema");<a name="line.427"></a>
<span class="sourceLineNo">428</span>        this.apply(c, this.getDatabaseInitialization());<a name="line.428"></a>
<span class="sourceLineNo">429</span><a name="line.429"></a>
<span class="sourceLineNo">430</span>        // Initialize update table<a name="line.430"></a>
<span class="sourceLineNo">431</span>        this.log.info("intializing update table");<a name="line.431"></a>
<span class="sourceLineNo">432</span>        this.apply(c, this.getUpdateTableInitialization());<a name="line.432"></a>
<span class="sourceLineNo">433</span>    }<a name="line.433"></a>
<span class="sourceLineNo">434</span>}<a name="line.434"></a>
<span class="sourceLineNo">435</span><a name="line.435"></a>




























































</pre>
</div>
</body>
</html>
